Skip to content

Add REVIEW.md with review guidelines - #411

Open
vchamarthi wants to merge 5 commits into
IntelPython:masterfrom
vchamarthi:review/review-md
Open

vchamarthi wants to merge 5 commits into
IntelPython:masterfrom
vchamarthi:review/review-md

Conversation

@vchamarthi

@vchamarthi vchamarthi commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

Adds REVIEW.md, the checklist reviewers (human and automated) apply to mkl_fft pull requests. It sits next to AGENTS.md and CONTRIBUTING.md, which cover layout and coding rules. Each rule is written as a check a reviewer can apply to the diff.

Sections:

  • How to verify: build, test and lint per CONTRIBUTING.md, a fix's test failing on base, an A/A run then the benchmark suite for performance, and an unpatched NumPy reference.
  • Correctness: NumPy/SciPy parity including result memory order, input not modified, the out= direct-write check, stride/s=/axes=/norm/dtype edge cases, MKL_INT overflow, workers semantics.
  • Patching NumPy and SciPy: idempotent, reentrant, thread-safe patching; optional SciPy and mkl-service.
  • Tests: fail on the base branch, independent reference, no duplicates, CI jobs that actually run tests.
  • Performance claims: before/after numbers with context and noise, every row read, memory claims measured, benchmark setup rules.
  • C backend and Cython, packaging and CI.
  • Automated pull requests: opened by the automation account or marked as AI-generated; one change in scope, failing test for fixes, measured gain for perf changes, no weakened tests, rule-file edits reviewed as policy. The agent does not edit CHANGELOG.md; a maintainer adds the entry before merge.
  • Pull request text: changelog entry with links for user-visible changes, the pull request template, no agent scaffolding text.

The rules are drawn from review comments on past pull requests in this repository (#370, #382, #384, #387, #389, #396, #397).

Lists what a pull request must show before merge: NumPy/SciPy parity and
layout/dtype edge cases, regression tests against an independent reference,
measured performance evidence, C backend and packaging checks, changelog
entries, and extra checks for automatically generated pull requests.

Signed-off-by: vchamarthi <venkata.sai.gireesh.chamarthi@intel.com>
…ainer edits

Signed-off-by: vchamarthi <venkata.sai.gireesh.chamarthi@intel.com>
@vchamarthi
vchamarthi marked this pull request as ready for review November 19, 2026 19:26
Copilot AI balanced review requested due to automatic review settings November 19, 2026 19:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The changelog requirement conflicts with the prohibition on automated PRs editing CHANGELOG.md and omits the existing exemption for changes that are not user-visible.

1 open issue
What changed in this PR

Adds REVIEW.md as a review checklist alongside AGENTS.md, defining the evidence expected for changes to mkl_fft.

Changes:

  • Defines correctness, testing, performance, backend, and packaging review checks.
  • Adds extra checks for automated pull requests and policy-file edits.
  • Sets expectations for changelog entries and pull request descriptions.

Repository verification was limited because /repo/AGENTS.md was unavailable.

File Description
REVIEW.md Adds review guidelines for human and automated reviewers.

Review effort: Balanced

Comment thread REVIEW.md Outdated
Comment on lines +115 to +116
- `CHANGELOG.md` has an entry under the `[dev]` section with a working link to the pull request and to
every issue it fixes.
…ull requests

- How to verify: build, test, lint, fail-on-base, A/A then ASV, and an
  unpatched NumPy reference.
- Automated pull requests: detect by author and branch; the agent does not
  write CHANGELOG.md, a maintainer adds the entry; review the current state.
- Correctness and tests: result memory order, input not modified, empty axes,
  longdouble, no duplicate tests, copyright header, stale asserts.
- Pull request text: keep the exemption for changes that are not user-visible,
  follow the pull request template.
- Rewritten as checks, under 100 lines.

Signed-off-by: vchamarthi <venkata.sai.gireesh.chamarthi@intel.com>
Refer to the automation account, build commands, helper functions,
benchmark names and changelog format by role or by their source of truth
(CONTRIBUTING.md) instead of naming them.

Signed-off-by: vchamarthi <venkata.sai.gireesh.chamarthi@intel.com>
Signed-off-by: vchamarthi <venkata.sai.gireesh.chamarthi@intel.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants